home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 9 / FreshFishVol9-CD2.bin / bbs / util / convert-2.01.lha / Convert / OS 2.0 / ConvertDocs.txt < prev    next >
Text File  |  1993-12-21  |  16KB  |  413 lines
  1.  
  2.  
  3.                       » » » » »  C O N V E R T  « « « « «
  4.  
  5.                        version 2.01, November 22th, 1992
  6.  
  7.                                  User Manual
  8.  
  9.         ***************************************************************
  10.  
  11.                                   Contents
  12.  
  13.                    1. Introduction - What does "Convert" ?
  14.                    2. Getting started
  15.                    3. Working with "Convert"
  16.                    4. Creating own conversion descriptions
  17.                    5. Error messages
  18.                    6. The shell version "Cvt"
  19.  
  20.  
  21.         ***************************************************************
  22.  
  23.  
  24.         1. Introduction
  25.  
  26.  
  27.         "Convert" is a powerful file conversion program. It covers the
  28.         application domain of all ASCII conversion tools between Amiga
  29.         and MS-DOS or any other computer system. This means, that file
  30.         conversion with "Convert" does NOT affect the physical format of
  31.         a file but only its contents. Physical conversion is not subject
  32.         of "Convert" and thus assigned to tools like "CrossDOS".
  33.  
  34.         "Convert" can be used to replace bytes or pairs of bytes in a
  35.         file by another byte or another pair of bytes or by nothing.
  36.         Therefore it can be used for tasks as follows:
  37.  
  38.         - replacing TABs in an ASCII file with blank character(s)
  39.         - stripping controls in an ASCII file
  40.         - converting ASCII-files between Amiga and MS-DOS, MS-DOS and
  41.           Amiga, Amiga and Mac, Mac and Sun, Amiga and Sun etc.
  42.  
  43.         What are "conversion descriptions" ?
  44.  
  45.         All that "Convert" needs, is a set of "replacement records"
  46.         which it can apply to its input files. This set is in the
  47.         following called "conversion description".
  48.         You can create your individual conversion descriptions by
  49.         creating several "replacement records" with a text editor using
  50.         the simple syntax described in chapter 4. These "records" are
  51.         stored to a conversion description file which can be parsed by
  52.         "Convert".
  53.  
  54.         The draft of specifying the conversion by a simple text file
  55.         makes "Convert" more powerful than any other conversion tool
  56.         and thus allows the application of "Convert" for almost all
  57.         conversion problems.
  58.  
  59.  
  60.         ***************************************************************
  61.  
  62.  
  63.         2. Getting started
  64.  
  65.  
  66.         Installation
  67.  
  68.         To install "Convert" double-click the "Install" icon. This short
  69.         shell script will do the following things:
  70.  
  71.         - Copying "reqtools.library" to the LIBS: directory.
  72.         - Copying "Cvt" to the C: directory.
  73.  
  74.         Furthermore, you must have a directory from where "Convert" reads
  75.         its conversion description files. If this directory is not the
  76.         same as the one where "Convert" is placed, you must assign the
  77.         logical device "CVT:" to it.
  78.         If "Convert" starts, first it looks in the current directory for
  79.         conversion descriptions. If it cannot find any matching file
  80.         (with the extension ".cvt"), it tries to get files from "CVT:".
  81.         NOTE: If "Convert" cannot find any description file, it will
  82.         NOT work !
  83.  
  84.  
  85.         Starting "Convert"
  86.  
  87.         You can start "Convert" by entering its name in the shell or by
  88.         double-clicking its icon.
  89.         If the program can locate at least one conversion description,
  90.         it opens a window which contains the control panel of "Convert".
  91.         This panel consists of following elements:
  92.  
  93.         * Source file list *
  94.  
  95.         This list on the left side of the buttons displays the names of
  96.         all files to be converted. The names are shown without path
  97.         name, except if you select two files in different directories
  98.         with the same name. Then the whole path name is displayed.
  99.  
  100.         * Conversion list *
  101.  
  102.         This list on the right side of the buttons displays the names
  103.         of the conversion description files which "Convert" could locate
  104.         at the start. The currently selected conversion description file
  105.         is shown by a high-lighted selection. By default the first name
  106.         of the list is selected.
  107.  
  108.         * Button "Clear" *
  109.  
  110.         You can use this button for deleting the current contents of the
  111.         source file list. If the files in this list have not been
  112.         converted yet, you will be asked to confirm your decision.
  113.  
  114.         * Button "Add files..." *
  115.  
  116.         If you click this button, a file requester will appear. You can
  117.         then select the files which you want to convert by clicking on
  118.         the file names while holding the SHIFT key. In addition there are
  119.         buttons for selecting and de-selecting all files and for pattern
  120.         matching (great, Nico ! :-) ).
  121.         Press the button "Ok" to add the selected files to the source file
  122.         list.
  123.  
  124.         * Button "Remove" *
  125.  
  126.         You can use this button for deleting the currently selected item
  127.         in the source file list. If the files in this list have not been
  128.         converted yet, you will be asked to confirm your decision.
  129.  
  130.         * Button "Start" *
  131.  
  132.         A click on this button starts the conversion process.
  133.  
  134.         * Button "About..." *
  135.  
  136.         Click this button to get short information about "Convert".
  137.  
  138.         * Button "Quit" *
  139.  
  140.         You can use this button for exiting "Convert". If the files in the
  141.         source file list have not been converted yet, you will be asked
  142.         to confirm your decision. You can also quit by clicking in the
  143.         close gadget of "Convert"'s window.
  144.  
  145.         * Cycle-gadget "Replace Original/Target Directory"
  146.  
  147.         This cycle-gadget can be used to toggle between the following two
  148.         modes:
  149.  
  150.         1. replacement mode
  151.         2. duplication mode
  152.  
  153.         The replacement mode is active, when the gadget shows the text
  154.         "Replace Original". Former versions of "Convert" (up to v1.12)
  155.         only provide this mode. In this mode "Convert" replaces the
  156.         original file with the converted version.
  157.         If you choose the duplication mode, a directory requester will
  158.         appear and you have to select a target directory, where "Convert"
  159.         will write the converted files. The name of the target directory
  160.         is then displayed within the cycle-gadget.
  161.  
  162.  
  163.         ***************************************************************
  164.  
  165.  
  166.         3. Working with "Convert"
  167.  
  168.  
  169.         When you have started "Convert" from the shell or from workbench,
  170.         it will open a window which contains a small control panel.
  171.         The source file list on the left side of the buttons is empty,
  172.         so the buttons "Clear" and "Start" are "ghosted".
  173.         Whenever you want to append files to the source file list, press
  174.         the button "Add files". A file requester will appear which allows
  175.         you to select the desired files. Press the "Ok" button to
  176.         append the files to the source file list.
  177.         If you do not want to overwrite the old files with the converted
  178.         versions, then you can specify a target directory for the
  179.         converted files by pressing the cycle-gadget at the botton of the
  180.         window. When you have chosen a target directory, its name will
  181.         be displayed within the gadget.
  182.         Before you start the conversion process, make sure you have
  183.         selected the correct conversion description in the list on the
  184.         right side of the buttons. The current description is shown
  185.         beneath the list.
  186.         The conversion process can be started by pressing the "Start"
  187.         button. "Convert" will open a window which gives you a simple
  188.         trace about the conversion.
  189.         If the conversion description contains no syntax errors, the
  190.         conversion should be performed without any problem. Otherwise
  191.         you have to correct the description file with a text editor.
  192.         At the end "Convert" informs you with a simple requester about
  193.         the success of the conversion process.
  194.         If there were no problems, you can return to the control panel.
  195.         Usually you will want to clear the source file list f